Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Storysource: Fix import error #25391

Merged
merged 1 commit into from
Jan 8, 2024
Merged

Conversation

unional
Copy link
Contributor

@unional unional commented Dec 30, 2023

This PR fixes a specific case of #23972 for @storybook/addon-storysource.

What I did

This works for storysource as the underlying ./dist/preset.js is still in CJS.

In general, there are a few issues:

  • the addons didn't have type: module in their package.json.
  • The consumer (vite or webpack I assume) are reading them as CJS as a result thus the error.
  • The {addon}/manager.js and {addon}/preview.js are meant for CJS consumption (as ESM will use the info in the exports field in the package.json). So they should be in CJS format. However, that means the code they reference should also in CJS which most of them are not (except for storysource's preset).

That means a better fix is adding the type: module and removing the {addon}/manager.js and {addon}/preview.js files.

I can create another PR for that (which needs more testing).

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

This works for storysource as the underlying `./dist/preset.js` is still in CJS
@unional unional requested a review from ndelangen as a code owner December 30, 2023 22:12
@ndelangen ndelangen changed the title fix: import error for storysource Storysource: Fix import error Jan 3, 2024
@shilman shilman self-assigned this Jan 8, 2024
@shilman shilman added the patch:yes Bugfix & documentation PR that need to be picked to main branch label Jan 8, 2024
@shilman shilman merged commit be9c746 into storybookjs:next Jan 8, 2024
55 of 57 checks passed
storybook-bot pushed a commit that referenced this pull request Jan 8, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 8, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 8, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 8, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 8, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 8, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 9, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 9, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 9, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 9, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 10, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 10, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 10, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 10, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 10, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 10, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
@github-actions github-actions bot mentioned this pull request Jan 10, 2024
25 tasks
storybook-bot pushed a commit that referenced this pull request Jan 10, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 10, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 10, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 10, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 10, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 11, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 11, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 11, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 11, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 11, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 11, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 11, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 11, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 12, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 12, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 12, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 12, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 12, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
storybook-bot pushed a commit that referenced this pull request Jan 12, 2024
Storysource: Fix import error
(cherry picked from commit be9c746)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Jan 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addon: storysource bug ci:normal patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants